Skip to main content

ServiceAPI

The ServiceAPI project provides a central service interfaces for accessing various API modules. This project allows you to do make operations - such as document download, document upload, form create, flow create, continuing flow etc. - on Form, Flow or any other external project.

ServiceAPI

The ServiceAPI class provides a central service interface for accessing various API modules. This class serves as the main access point to different system functions and APIs.

Properties

NameDescription
DelegationAPIThe Delegation API is a powerful tool designed for managing user delegations within an organization. This API allows for the creation, retrieval, and management of delegation entities, which can define permissions and access rights across different users and resources. By utilizing this API, organizations can streamline the process of granting temporary access, ensuring efficient collaboration and resource management.
AuthenticationAPIThe AuthenticationAPI class provides methods for handling various authentication mechanisms within the service API. It includes login functionalities for basic authentication, token authentication, and access token-based authentication.
DocumentManagementAPIThe DocumentManagementAPI class provides a comprehensive set of methods for managing documents within the system. This includes functionalities for creating, retrieving, updating, and deleting documents, as well as managing their associated metadata and permissions. The API also supports operations for handling document versions, shortcuts, and folder structures, enabling users to efficiently organize and manipulate their document assets.
SharedAPIThe Shared API allows you to create and manage shareable links with specific functionalities, such as starting workflows, filling out forms, and accessing files within a document management system. This API facilitates controlled access to resources by configuring various parameters such as link type, expiration, user permissions, and view settings.
FormManagerAPIThe FormManagerAPI is a powerful API that allows users to create, manage, and process dynamic forms. This API facilitates operations such as form design, management of form instances, data updates, and retrieval of form control values.
OfficeWebAppsAPIThe OfficeWebAppsAPI class provides methods to interact with Office Web Apps, including functionality to retrieve action URLs for specific documents or actions.
StudioAPIThe StudioAPI class provides methods to interact with various Studio-related resources. This API handles sending requests to retrieve information such as deployments, versions, projects, flows, and processes.
BuildManagerAPIThe BuildManagerAPI class provides functionalities for managing build operations.
ConfigurationAPIThe ConfigurationAPI class provides access to configuration management functionalities, allowing for the retrieval of configuration data based on specified parameters.
HumanResourcesAPIThe HumanResourcesAPI class provides methods for accessing user information within the service API. It includes functionalities for retrieving details of the current user, fetching users by ID, and obtaining user information by username, with built-in telemetry and exception handling.
MenuManagerAPIThe Menu Manager API provides a robust and scalable solution for managing user-specific menu structures, profiles, and menu item parameters. It allows for the dynamic generation of menus based on user roles and profiles, while also supporting detailed reporting and telemetry integration for enhanced performance monitoring. This API is designed to offer flexibility and ease of integration with enterprise applications.
DataSourceManagerAPIThe DataSourceManager API provides functionality for managing external data sources such as databases, REST services, and other third-party providers. It enables seamless access and querying of data across multiple environments, abstracting complex connection management and query execution logic. This API is particularly useful in scenarios where dynamic and diverse data access is required within applications.
WorkflowManagerAPIThe WorkflowManagerAPI class provides methods for managing workflows within the system, including creating, starting, and continuing workflows, as well as retrieving user approvals and process requests.

Constructors

NameDescription
ServiceAPI(loginParameters, apiUrlOrInstanceName, logSeverity, telemetryCollectorHolder)Creates a ServiceAPI instance with Token Authentication.
ServiceAPI(loginParameters, apiUrlOrInstanceName, logSeverity, telemetryCollectorHolder)Creates a ServiceAPI instance with Access Token Authentication.
ServiceAPI(loginParameters, apiUrlOrInstanceName, logSeverity, telemetryCollectorHolder)Creates a ServiceAPI instance with Basic Authentication.

Methods

NameDescription
GetToken()Returns the token assigned for the current session.
GetInstanceNameFromDomain(domainAddress)Extracts the instance name from a given domain address.